home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / p_man / cat3 / Xm / XmClipboardCopy.z / XmClipboardCopy
Text File  |  1998-10-30  |  8KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddCCCCooooppppyyyy((((3333XXXX))))       UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV       XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddCCCCooooppppyyyy((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddCCCCooooppppyyyy - A clipboard function that copies a data
  10.           item to temporary storage for later copying to clipboard
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           #include <Xm/CutPaste.h>
  14.           int XmClipboardCopy (_d_i_s_p_l_a_y, _w_i_n_d_o_w, _i_t_e_m__i_d, _f_o_r_m_a_t__n_a_m_e,
  15.                   _b_u_f_f_e_r, _l_e_n_g_t_h, _p_r_i_v_a_t_e__i_d, _d_a_t_a__i_d)
  16.                   Display * _d_i_s_p_l_a_y;
  17.                   Window  _w_i_n_d_o_w;
  18.                   long    _i_t_e_m__i_d;
  19.                   char    * _f_o_r_m_a_t__n_a_m_e;
  20.                   XtPointer       _b_u_f_f_e_r;
  21.                   unsigned long   _l_e_n_g_t_h;
  22.                   long    _p_r_i_v_a_t_e__i_d;
  23.                   long    * _d_a_t_a__i_d;
  24.           (vvvvooooiiiidddd)
  25.  
  26.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  27.           This page documents Motif 2.1.
  28.  
  29.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  30.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddCCCCooooppppyyyycopies a data item to temporary storage.  The
  31.           data item is moved from temporary storage to the clipboard
  32.           data structure when a call to XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddEEEEnnnnddddCCCCooooppppyyyy is made.
  33.           Additional calls to XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddCCCCooooppppyyyy before a call to
  34.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddEEEEnnnnddddCCCCooooppppyyyy add additional data item formats to the
  35.           same data item or append data to an existing format. Formats
  36.           are described in the _I_n_t_e_r-_C_l_i_e_n_t _C_o_m_m_u_n_i_c_a_t_i_o_n _C_o_n_v_e_n_t_i_o_n_s
  37.           _M_a_n_u_a_l (ICCCM) as targets.
  38.  
  39.           NNNNOOOOTTTTEEEE:::: Do not call XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddCCCCooooppppyyyy before a call to
  40.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttCCCCooooppppyyyy has been made. The latter function
  41.           allocates temporary storage required by XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddCCCCooooppppyyyy.
  42.  
  43.           If the _b_u_f_f_e_r argument is NULL, the data is considered to be
  44.           passed by name.  When data that has been passed by name is
  45.           later requested by another application, the application that
  46.           owns the data receives a callback with a request for the
  47.           data. The application that owns the data must then transfer
  48.           the data to the clipboard with the XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddCCCCooooppppyyyyBBBByyyyNNNNaaaammmmeeee
  49.           function.  When a data item that was passed by name is
  50.           deleted from the clipboard, the application that owns the
  51.           data receives a callback stating that the data is no longer
  52.           needed.
  53.  
  54.           For information on the callback function, see the callback
  55.           argument description for XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttCCCCooooppppyyyy.
  56.  
  57.           _d_i_s_p_l_a_y   Specifies a pointer to the DDDDiiiissssppppllllaaaayyyy structure that
  58.                     was returned in a previous call to XXXXOOOOppppeeeennnnDDDDiiiissssppppllllaaaayyyy or
  59.                     XXXXttttDDDDiiiissssppppllllaaaayyyy.
  60.  
  61.  
  62.  
  63.      Page 1                                         (printed 10/24/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddCCCCooooppppyyyy((((3333XXXX))))       UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV       XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddCCCCooooppppyyyy((((3333XXXX))))
  71.  
  72.  
  73.  
  74.           _w_i_n_d_o_w    Specifies the window ID of a widget that relates
  75.                     the application window to the clipboard. The
  76.                     widget's window ID can be obtained through
  77.                     XXXXttttWWWWiiiinnnnddddoooowwww.  The same application instance should
  78.                     pass the same window ID to each of the clipboard
  79.                     functions that it calls.
  80.  
  81.           _i_t_e_m__i_d   Specifies the number assigned to this data item.
  82.                     This number was returned by a previous call to
  83.                     XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttCCCCooooppppyyyy.
  84.  
  85.           _f_o_r_m_a_t__n_a_m_e
  86.                     Specifies the name of the format in which the data
  87.                     item is stored on the clipboard. The format was
  88.                     known as target in the ICCCM.
  89.  
  90.           _b_u_f_f_e_r    Specifies the buffer from which the clipboard
  91.                     copies the data.
  92.  
  93.           _l_e_n_g_t_h    Specifies the length, in bytes, of the data being
  94.                     copied to the clipboard.
  95.  
  96.           _p_r_i_v_a_t_e__i_d
  97.                     Specifies the private data that the application
  98.                     wants to store with the data item.
  99.  
  100.           _d_a_t_a__i_d   Specifies an identifying number assigned to the
  101.                     data item that uniquely identifies the data item
  102.                     and the format.  This argument is required only
  103.                     for data that is passed by name.
  104.  
  105.      RRRREEEETTTTUUUURRRRNNNN
  106.           _X_m_C_l_i_p_b_o_a_r_d_S_u_c_c_e_s_s
  107.                     The function was successful.
  108.  
  109.           _X_m_C_l_i_p_b_o_a_r_d_L_o_c_k_e_d
  110.                     The function failed because the clipboard was
  111.                     locked by another application. The application can
  112.                     continue to call the function again with the same
  113.                     parameters until the lock goes away. This gives
  114.                     the application the opportunity to ask if the user
  115.                     wants to keep trying or to give up on the
  116.                     operation.
  117.  
  118.           _X_m_C_l_i_p_b_o_a_r_d_F_a_i_l
  119.                     The function failed because XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttCCCCooooppppyyyy
  120.                     was not called or because the data item contains
  121.                     too many formats.
  122.  
  123.      RRRREEEELLLLAAAATTTTEEEEDDDD
  124.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddCCCCooooppppyyyyBBBByyyyNNNNaaaammmmeeee(3), XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddEEEEnnnnddddCCCCooooppppyyyy(3), and
  125.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttCCCCooooppppyyyy(3).
  126.  
  127.  
  128.  
  129.      Page 2                                         (printed 10/24/98)
  130.  
  131.  
  132.  
  133.